<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python documentation Index' />
<link rel="first" href="lib.html" title='Python library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="module-xdrlib.html" />
<link rel="prev" href="module-robotparser.html" />
<link rel="parent" href="fileformats.html" />
<link rel="next" href="netrc-objects.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>9.4 netrc -- netrc file processing</title>
</head>
<body>
<div class="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="9.3 robotparser  "
  href="module-robotparser.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="9. file Formats"
  href="fileformats.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="9.4.1 netrc Objects"
  href="netrc-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-robotparser.html">9.3 robotparser  </a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="fileformats.html">9. File Formats</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="netrc-objects.html">9.4.1 netrc Objects</a>
</div>
<hr /></div>
</div>
<!--End of Navigation Panel-->

<h1><a name="SECTION0011400000000000000000">
9.4 <tt class="module">netrc</tt> --
         netrc file processing</a>
</h1>

<p>
<a name="module-netrc"></a>

<p>

<span class="versionnote">New in version 1.5.2.</span>

<p>
The <tt class="class">netrc</tt> class parses and encapsulates the netrc file format
used by the <span class="Unix">Unix</span> <b class="program">ftp</b> program and other FTP clients.

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-2089' xml:id='l2h-2089' class="class">netrc</tt></b>(</nobr></td>
  <td><var></var><big>[</big><var>file</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
A <tt class="class">netrc</tt> instance or subclass instance encapsulates data from 
a netrc file.  The initialization argument, if present, specifies the
file to parse.  If no argument is given, the file <span class="file">.netrc</span> in the
user's home directory will be read.  Parse errors will raise
<tt class="exception">NetrcParseError</tt> with diagnostic information including the
file name, line number, and terminating token.
</dl>

<p>
<dl><dt><b><span class="typelabel">exception</span>&nbsp;<tt id='l2h-2090' xml:id='l2h-2090' class="exception">NetrcParseError</tt></b></dt>
<dd>
Exception raised by the <tt class="class">netrc</tt> class when syntactical errors
are encountered in source text.  Instances of this exception provide
three interesting attributes:  <tt class="member">msg</tt> is a textual explanation
of the error, <tt class="member">filename</tt> is the name of the source file, and
<tt class="member">lineno</tt> gives the line number on which the error was found.
</dd></dl>

<p>

<p><br /></p><hr class='online-navigation' />
<div class='online-navigation'>
<!--Table of Child-Links-->
<a name="CHILD_LINKS"><strong>Subsections</strong></a>

<ul class="ChildLinks">
<li><a href="netrc-objects.html">9.4.1 netrc Objects</a>
</ul>
<!--End of Table of Child-Links-->
</div>

<div class="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="9.3 robotparser  "
  href="module-robotparser.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="9. file Formats"
  href="fileformats.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="9.4.1 netrc Objects"
  href="netrc-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-robotparser.html">9.3 robotparser  </a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="fileformats.html">9. File Formats</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="netrc-objects.html">9.4.1 netrc Objects</a>
</div>
</div>
<hr />
<span class="release-info">Release 2.5.1, documentation updated on 18th April, 2007.</span>
</div>
<!--End of Navigation Panel-->
<address>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</address>
</body>
</html>
